PBCatMoveSync

PBCatMoveSync
Header:	Files.h		Carbon status:	Supported

Moves files or directories from one directory to another on the same volume.

OSErr PBCatMoveSync (
    CMovePBPtr paramBlock
);

paramBlock: A pointer to a catalog move parameter block.

function result: A result code.

DISCUSSION

The relevant fields of the parameter block are:

ioCompletion

On input, a pointer to a completion function.
ioResult

On output, the result code of the function.
ioNamePtr

On input, a pointer to the name of the file or directory to be moved
ioVRefNum

On input, a volume specification.
ioNewName

On input, a pointer to the name of the directory into which the file or directory is to be moved
ioNewDirID

On input, the directory ID of the directory into which the file or directory is to be moved, if ioNewName is NULL. If ioNewName is not NULL, this is the parent directory ID of the directory into which the file or directory is to be moved.

It is usually simplest to specify the destination directory by passing its directory ID in the ioNewDirID field and by setting ioNewName to NULL.
ioDirID

On input, the parent directory ID of the file or directory to be moved.

PBCatMoveSync is strictly a file catalog operation; it does not actually change the location of the file or directory on the disk.

The source file or directory should be specified by its volume, parent directory ID, and partial pathname.

The PBCatMoveSync function cannot move a file or directory to another volume (that is, ioVRefNum is used in specifying both the source and the destination). Also, you cannot use it to rename files or directories; to rename a file or directory, use PBHRenameSync.

If a file ID reference exists for the file, the file ID reference remains with the moved file.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.